<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="../css/docs.css" type="text/css" rel="stylesheet" />
<link href="../css/prettify.css" type="text/css" rel="stylesheet" />
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
<div id="api-info-block">
<div class="api-level">H3C CAS云管理平台</div>
</div>
<div id="jd-header">
<h1>查询租户的虚拟机模板列表</h1>
</div>
<div id="jd-content">
<div class="jd-descr">
<p>根据提供的特定条件，查询租户的虚拟机模板列表。</p>
<h2><a name="uri"></a>接口 URI</h2>
<p>/cas/casrs/user/templet</p>
<h2><a name="access"></a>访问方法</h2>
<dl>
  <dt><b>HTTP 方法</b></dt>
  <dd>GET</dd>
  <dt><b>参数</b></dt>
  <table id="pubmethods" class="jd-sumtable">
    <tbody>
      <tr>
        <th colspan="2">查询参数（Query Parameter）</th>
      </tr>
      <tr>
        <td class="jd-typecol">offset</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">返回的第一条记录在总结果集中的位置</span>。
          <div class="jd-descrdiv">整数（int）类型，非必须，缺省为 0。如果传入参数小于 0，则使用缺省值 0。</div>        </td>
      </tr>
      <tr class="alt-color">
        <td class="jd-typecol">limit</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">返回记录总数。</span>
        <div class="jd-descrdiv">整数（int）类型，非必须，缺省为 10。如果传入参数小于 0，则使用缺省值 10。</div>        </td>
      </tr>
      <tr>
        <td class="jd-typecol">orderBy</td>
        <td class="jd-linkcol">排序字段。
          <div class="jd-descrdiv">字符串（String）类型，非必须。</div></td>
      </tr>
      <tr class="alt-color">
        <td class="jd-typecol">userId</td>
        <td class="jd-linkcol"><span class="sympad">用户ID。</span>
            <div class="jd-descrdiv">整数（long）类型，必须。</div></td>
      </tr>
      <tr >
        <td class="jd-typecol">total</td>
        <td class="jd-linkcol"><span class="sympad">仅返回符合条件的记录数</span> 。
          <div class="jd-descrdiv">布尔（boolean）类型，非必须，缺省为 false。为 true 时 <span class="jd-typecol">offset</span>、<span class="jd-typecol">limit</span>和<span class="jd-typecol">orderBy</span>属性无效，返回消息体为空，消息头 Total
            属性返回符合条件的记录数。</div></td>
      </tr>
  </table>
</dl>
<h2><a name="result"></a>返回结果</h2>
<dl>
  <dt><b>状态码</b></dt>
  <dd>
  <ul>
    <li>200(OK)：成功。</li>
  </ul>
  </dd>
  <dt><b>消息头</b></dt>
  <br>
  当 total 参数为 true 时，Total 属性返回符合条件的总记录数。此时，无消息体。
  <div class="source"><pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Total: 7</pre></div>
  <dt><b>消息体</b></dt>
  <div class="source"><pre class="prettyprint lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;list&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;85&lt;/id&gt;<br>    &lt;name&gt;win7_it_virtio-templet&lt;/name&gt;<br>    &lt;memory&gt;2048&lt;/memory&gt;<br>    &lt;cpu&gt;2&lt;/cpu&gt;<br>    &lt;status&gt;0&lt;/status&gt;<br>    &lt;uuid&gt;bc12460e-3522-4de5-8ead-6705f340e594&lt;/uuid&gt;<br>    &lt;osBit&gt;x86_64&lt;/osBit&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>    &lt;createDate&gt;2012-05-08T14:07:38+08:00&lt;/createDate&gt;<br>    &lt;storageCapacity&gt;24&lt;/storageCapacity&gt;<br>  &lt;/domain&gt;<br><br>	...
<br>&lt;/list&gt;</pre>
  </div>
</dl>
<dt><a name="detail"></a><b>元素含义</b></dt>
<table class="jd-sumtable" id="pubmethods">
  <tbody>
    <tr>
      <th colspan="2"><span class="prettyprint lang-xml">domain</span>各子元素</th>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">id</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机模板 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">name</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机模板名称。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">description</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机模板描述信息。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">memory</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机内存大小，</span>单位（M） <span class="sympad">。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">cpu</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机CPU个数。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">status</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机状态。 2：运行 3：关闭 4：暂停。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">uuid</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机UUID。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">osBit</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机安装的操作系统位数。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">system</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机安装的操作系统类型。0：Windows 1：Linux。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">createDate</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机创建日期。</span>
          <div class="jd-descrdiv"><span class="sympad">日期</span>（Date）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">storageCapacity</span></td>
      <td class="jd-linkcol"><span class="sympad">虚拟机镜像存储大小。</span>
          单位（G）
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
</table>
<p>&nbsp;</p>
<h2><a name="example"></a>应用举例</h2>
    <p>1.统计用户ID为5的虚拟机模板数目。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">GET http://localhost:8080/cas/casrs/user/templet?userId=6&amp;total=true
accept: application/xml
...
        </pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source"><pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Server: Apache-Coyote/1.1<br>Total: 1<br>Content-Type: application/xml<br>Content-Length: 0<br><br></pre>
      </div>
    </dl>
	<p>2.查询用户ID为5的虚拟机模板列表信息，从第1条开始查询10条记录，并通过虚拟机模板ID对查询结果进行排序。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">GET http://localhost:8080/cas/casrs/user/templet?offset=0&amp;limit=10&amp;sortField=id&amp;userId=6
accept: application/xml
...
        </pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source"><pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Content-Type: application/xml
...<br>&lt;list&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;85&lt;/id&gt;<br>    &lt;name&gt;win7_it_virtio-templet&lt;/name&gt;<br>    &lt;memory&gt;2048&lt;/memory&gt;<br>    &lt;cpu&gt;2&lt;/cpu&gt;<br>    &lt;status&gt;0&lt;/status&gt;<br>    &lt;uuid&gt;bc12460e-3522-4de5-8ead-6705f340e594&lt;/uuid&gt;<br>    &lt;osBit&gt;x86_64&lt;/osBit&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>    &lt;createDate&gt;2012-05-08T14:07:38+08:00&lt;/createDate&gt;<br>    &lt;storageCapacity&gt;24&lt;/storageCapacity&gt;<br>  &lt;/domain&gt;<br>&lt;/list&gt;<br><br></pre>
      </div>
    </dl>
</div>
</div>
</div>
</body>
</html>